API

Logistics APIs

POST logistics/tracking-number-series

Create new tracking number

HTTP method POST
URI https://api.rambase.net/logistics/tracking-number-series
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 4133, version 10

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<TrackingNumberSeries>
2
     <Type
Type

Required/mandatory field

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Applicable domain values can be found here

>{String}</Type>
3
     <Range
Range

This field is optional.

>
4
          <StartTrackingNumber
StartTrackingNumber

First tracking number in the series

Minimum value: 0

This field is optional.

>{Long}</StartTrackingNumber>
5
          <EndTrackingNumber
EndTrackingNumber

Last tracking number in the series

Minimum value: 0

This field is optional.

>{Long}</EndTrackingNumber>
6
     </Range>
7
</TrackingNumberSeries>
1
{
2
     "trackingNumberSeries": {
3
          "type
Type

Required/mandatory field

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Applicable domain values can be found here

": "{String}",
4
          "range
Range

This field is optional.

": {
5
               "startTrackingNumber
StartTrackingNumber

First tracking number in the series

Minimum value: 0

This field is optional.

": "{Long}",
6
               "endTrackingNumber
EndTrackingNumber

Last tracking number in the series

Minimum value: 0

This field is optional.

": "{Long}"
7
          }
8
     }
9
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<TrackingNumberSeries>
2
     <TrackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

>{Integer}</TrackingNumberSeriesId>
3
     <Status
Status

Status of tracking number

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

>{String}</Type>
6
     <Description
Description

Tracking number series description

>{String}</Description>
7
     <TrackingUri
TrackingUri

URL to shipping providers tracking system

>{String}</TrackingUri>
8
     <Modulus
Modulus

The number by which a logarithm to one base is multiplied to give the corresponding logarithm to another base

Possible domain values can be found here

>{String}</Modulus>
9
     <Prefix
Prefix

Prefix when creating the tracking number

>{String}</Prefix>
10
     <Suffix
Suffix

To be used as suffix when creating the tracking number

>{String}</Suffix>
11
     <WarningRole>
12
          <RoleId
RoleId

Role identifier

>{Integer}</RoleId>
13
          <Name
Name

Name of the role

>{String}</Name>
14
          <RoleLink
RoleLink

Role reference

>{String}</RoleLink>
15
     </WarningRole>
16
     <Range>
17
          <StartTrackingNumber
StartTrackingNumber

First tracking number in the series

>{Long}</StartTrackingNumber>
18
          <EndTrackingNumber
EndTrackingNumber

Last tracking number in the series

>{Long}</EndTrackingNumber>
19
          <WarningTrackingNumber
WarningTrackingNumber

When this tracking number is reached, a warning will be sent to users that belongs to a specific role

>{Long}</WarningTrackingNumber>
20
          <CurrentTrackingNumber
CurrentTrackingNumber

The tracking number that will be used for next package/shipment

>{Long}</CurrentTrackingNumber>
21
     </Range>
22
     <NextRange>
23
          <StartTrackingNumber
StartTrackingNumber

First tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended

>{Long}</StartTrackingNumber>
24
          <EndTrackingNumber
EndTrackingNumber

Last tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended

>{Long}</EndTrackingNumber>
25
          <WarningTrackingNumber
WarningTrackingNumber

Warning tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended

>{Long}</WarningTrackingNumber>
26
     </NextRange>
27
</TrackingNumberSeries>
1
{
2
     "trackingNumberSeries": {
3
          "trackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

": "{Integer}",
4
          "status
Status

Status of tracking number

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

": "{String}",
7
          "description
Description

Tracking number series description

": "{String}",
8
          "trackingUri
TrackingUri

URL to shipping providers tracking system

": "{String}",
9
          "modulus
Modulus

The number by which a logarithm to one base is multiplied to give the corresponding logarithm to another base

Possible domain values can be found here

": "{String}",
10
          "prefix
Prefix

Prefix when creating the tracking number

": "{String}",
11
          "suffix
Suffix

To be used as suffix when creating the tracking number

": "{String}",
12
          "warningRole": {
13
               "roleId
RoleId

Role identifier

": "{Integer}",
14
               "name
Name

Name of the role

": "{String}",
15
               "roleLink
RoleLink

Role reference

": "{String}"
16
          },
17
          "range": {
18
               "startTrackingNumber
StartTrackingNumber

First tracking number in the series

": "{Long}",
19
               "endTrackingNumber
EndTrackingNumber

Last tracking number in the series

": "{Long}",
20
               "warningTrackingNumber
WarningTrackingNumber

When this tracking number is reached, a warning will be sent to users that belongs to a specific role

": "{Long}",
21
               "currentTrackingNumber
CurrentTrackingNumber

The tracking number that will be used for next package/shipment

": "{Long}"
22
          },
23
          "nextRange": {
24
               "startTrackingNumber
StartTrackingNumber

First tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended

": "{Long}",
25
               "endTrackingNumber
EndTrackingNumber

Last tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended

": "{Long}",
26
               "warningTrackingNumber
WarningTrackingNumber

Warning tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended

": "{Long}"
27
          }
28
     }
29
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101516 HTTP 400 Shipping service {0} is already assigned to another tracking number series: {1}
Error 101358 HTTP 400 Incremental method is mandatory for tracking number series
Error 101547 HTTP 400 The combination of that type is shipment and incremental method is that each package in a shipment will get a separate tracking number, is not valid.
Error 101356 HTTP 400 Start number and end number is mandatory for tracking number series
Error 101549 HTTP 400 Numbers in tracking number series cannot be negative
Error 101548 HTTP 400 End number must be higher than start number